Skip to content

Add summary table to the unicodedata doc#149957

Merged
StanFromIreland merged 2 commits into
python:mainfrom
StanFromIreland:unicodedata-summary
May 20, 2026
Merged

Add summary table to the unicodedata doc#149957
StanFromIreland merged 2 commits into
python:mainfrom
StanFromIreland:unicodedata-summary

Conversation

@StanFromIreland
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland commented May 17, 2026

This was suggested by @merwok some time ago (I can't remember where). The patch adds a little summary table like the one in the math module docs. I however, excluded the constants, as most people don't care about them anyway.

@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 17, 2026
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 17, 2026 •
edited by StanFromIreland
Loading

Documentation build overview

📚 cpython-previews | 🛠️ Build #32727141 | 📁 Comparing 889fb5f against main (acefff9)

  🔍 Preview build  

1 file changed
± library/unicodedata.html

clin1234
clin1234 reviewed May 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@clin1234 clin1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@serhiy-storchaka
Copy link
Copy Markdown
Member

serhiy-storchaka commented May 18, 2026

I am not a great fun of such tables. They take up the entire screen, and you have to scroll through them before getting to the documentation for specific functions. Can we add the list of names to the left panel?

malemburg
malemburg approved these changes May 18, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@malemburg malemburg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@StanFromIreland
Copy link
Copy Markdown
Member Author

StanFromIreland commented May 18, 2026

Can we add the list of names to the left panel?

I don't think that solves the original problem, they do not provide any summary/overview of what all the functions do. Additionally, I agree it would be good, however it is and isn't possible. It would have to be enabled doc-wide, which we have done before (91ddde4), but have had to revert (c9d2bc6) because it was too disruptive.

@serhiy-storchaka
Copy link
Copy Markdown
Member

serhiy-storchaka commented May 18, 2026

Well, I do not actively oppose this. This module is pretty small. But in some cases it seems excessive.

@StanFromIreland
Copy link
Copy Markdown
Member Author

StanFromIreland commented May 18, 2026 •
edited
Loading

If it were graphlib, I'd agree ;-) In this case I think it is useful, it is a slightly messy jumble of various functions. How opposed are you in this specific case?

@StanFromIreland StanFromIreland added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 18, 2026
@StanFromIreland StanFromIreland merged commit 87a879f into python:main May 20, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs May 20, 2026
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented May 20, 2026

Thanks @StanFromIreland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@StanFromIreland StanFromIreland deleted the unicodedata-summary branch May 20, 2026 15:04
@StanFromIreland
Copy link
Copy Markdown
Member Author

StanFromIreland commented May 20, 2026

I confirmed Serhiy's not blocking, merged, thanks all!

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 20, 2026

GH-150161 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 20, 2026
StanFromIreland added a commit that referenced this pull request May 20, 2026
@miss-islington @StanFromIreland
[3.15] Add summary table to the unicodedata doc (GH-149957) (#150161)
dea552c 
(cherry picked from commit 87a879f)

Co-authored-by: Stan Ulbrych <stan@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwok merwok merwok approved these changes

@malemburg malemburg malemburg approved these changes

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

+1 more reviewer

@clin1234 clin1234 clin1234 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news topic-unicode

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@StanFromIreland @serhiy-storchaka @merwok @malemburg @clin1234